<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>netaddr</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >netaddr</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;netaddr
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="netaddr-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package netaddr</h1><p class="nomargin-top"><span class="codelink"><a href="netaddr-pysrc.html">source&nbsp;code</a></span></p>
<p>network address manipulation, done Pythonically</p>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        0.6
      </p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Submodules</span></td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li class="private"> <strong class="uidlink"><a href="netaddr.address-module.html" onclick="show_private();">netaddr.address</a></strong>: <em class="summary">network address classes (IP, EUI) and associated aggregate classes 
        (CIDR, Wildcard and IPRange).</em>    </li>
    <li class="private"> <strong class="uidlink"><a href="netaddr.core-module.html" onclick="show_private();">netaddr.core</a></strong>: <em class="summary">Classes and routines that are common to various netaddr sub 
        modules.</em>    </li>
    <li class="private"> <strong class="uidlink"><a href="netaddr.eui-module.html" onclick="show_private();">netaddr.eui</a></strong>: <em class="summary">Provides access to public network address information published by 
        the IEEE.</em>    </li>
    <li> <strong class="uidlink"><a href="netaddr.ip-module.html">netaddr.ip</a></strong>: <em class="summary">Provides access to public network address information published by 
        IANA.</em>    </li>
    <li> <strong class="uidlink"><a href="netaddr.misc-module.html">netaddr.misc</a></strong>: <em class="summary">Miscellanous functions and classes.</em>    </li>
    <li class="private"> <strong class="uidlink"><a href="netaddr.strategy-module.html" onclick="show_private();">netaddr.strategy</a></strong>: <em class="summary">network address conversion logic, constants and shared strategy 
        objects.</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Classes</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.AddrFormatError-class.html" class="summary-name">AddrFormatError</a><br />
      An Exception indicating that a network address format is not 
        recognised.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.AddrConversionError-class.html" class="summary-name">AddrConversionError</a><br />
      An Exception indicating a failure to convert between address types 
        or notations.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.IP-class.html" class="summary-name">IP</a><br />
      Represents <b>individual</b> IPv4 and IPv6 addresses.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.IPRange-class.html" class="summary-name">IPRange</a><br />
      Represents arbitrary contiguous blocks of IPv4 and IPv6 addresses 
        using only a lower and upper bound IP address.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.IPRangeSet-class.html" class="summary-name">IPRangeSet</a><br />
      <b>*EXPERIMENTAL*</b> A customised Python set class that deals with
        collections of IPRange class and subclass instances.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.CIDR-class.html" class="summary-name">CIDR</a><br />
      Represents blocks of IPv4 and IPv6 addresses using CIDR (Classless 
        Inter-Domain Routing) notation.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.Wildcard-class.html" class="summary-name">Wildcard</a><br />
      Represents blocks of IPv4 addresses using a wildcard or glob style 
        syntax.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.address.EUI-class.html" class="summary-name">EUI</a><br />
      Represents an IEEE EUI (Extended Unique Identifier) indentifier.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.OUI-class.html" class="summary-name">OUI</a><br />
      Represents an individual IEEE OUI (Organisationally Unique 
        Identifier) identifier.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.IAB-class.html" class="summary-name">IAB</a><br />
      Represents an individual IEEE IAB (Individual Address Block) 
        identifier.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="netaddr.eui.NotRegisteredError-class.html" class="summary-name">NotRegisteredError</a><br />
      An Exception indicating that an OUI or IAB was not found in the 
        IEEE Registry.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="netaddr-module.html#nrange" class="summary-sig-name">nrange</a>(<span class="summary-sig-arg">start</span>,
        <span class="summary-sig-arg">stop</span>,
        <span class="summary-sig-arg">step</span>=<span class="summary-sig-default">1</span>,
        <span class="summary-sig-arg">fmt</span>=<span class="summary-sig-default">None</span>)</span><br />
      An xrange work alike generator that produces sequences of IP 
      addresses based on start and stop addresses, in intervals of step 
      size.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="netaddr.address-pysrc.html#nrange">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="AT_INET"></a><span class="summary-name">AT_INET</span> = <code title="4">4</code><br />
      IPv4 address type constant.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="AT_INET6"></a><span class="summary-name">AT_INET6</span> = <code title="6">6</code><br />
      IPv6 address type constant.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="AT_LINK"></a><span class="summary-name">AT_LINK</span> = <code title="48">48</code><br />
      MAC/EUI-48 address type constant.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="AT_EUI64"></a><span class="summary-name">AT_EUI64</span> = <code title="64">64</code><br />
      EUI-64 address type constant.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="ST_IPV4"></a><span class="summary-name">ST_IPV4</span> = <code title="IPv4StrategyOpt(32, 8, '.', 4, 10, False)">IPv4StrategyOpt(32, 8, '.', 4, 10, False)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="ST_IPV6"></a><span class="summary-name">ST_IPV6</span> = <code title="IPv6Strategy(128, 16, ':', 6, 16, False)">IPv6Strategy(128, 16, ':', 6, 16, False)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="ST_EUI48"></a><span class="summary-name">ST_EUI48</span> = <code title="EUI48Strategy(48, 8, '-', 48, 16, True)">EUI48Strategy(48, 8, '-', 48, 16, True)</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="ST_EUI64"></a><span class="summary-name">ST_EUI64</span> = <code title="AddrStrategy(64, 8, '-', 64, 16, True)">AddrStrategy(64, 8, '-', 64, 16, True)</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="nrange"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">nrange</span>(<span class="sig-arg">start</span>,
        <span class="sig-arg">stop</span>,
        <span class="sig-arg">step</span>=<span class="sig-default">1</span>,
        <span class="sig-arg">fmt</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="netaddr.address-pysrc.html#nrange">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>An xrange work alike generator that produces sequences of IP addresses
  based on start and stop addresses, in intervals of step size.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>start</code></strong> - first IP address string or <a 
          href="netaddr.address.IP-class.html" class="link">IP</a> object 
          in range.</li>
        <li><strong class="pname"><code>stop</code></strong> - last IP address string or <a href="netaddr.address.IP-class.html"
          class="link">IP</a> object in range</li>
        <li><strong class="pname"><code>step</code></strong> - (optional) size of step between address in range. (Default: 1)</li>
        <li><strong class="pname"><code>fmt</code></strong> - (optional) callable used on addresses returned. (Default: None - 
          <a href="netaddr.address.IP-class.html" class="link">IP</a> 
          objects). Supported options :-
          <ul>
            <li>
              <code>str</code> - IP address strings
            </li>
            <li>
              <code>int</code>, <code>long</code> - IP address integer 
              (network byte order)
            </li>
            <li>
              <code>hex</code> - IP address as a hexadecimal number
            </li>
            <li>
              <a href="netaddr.address.IP-class.html" class="link">IP</a> 
              class/subclass or callable that accepts 
              <code>addr_value</code> and <code>addr_type</code> arguments.
            </li>
          </ul></li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >netaddr</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Jan 21 23:41:05 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
